/*********************************************************************
 * Copyright (C) 2004 Andrew Khan
 * <p>
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * <p>
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * <p>
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 ***************************************************************************/

package jxl.write.biff;

import jxl.StringFormulaCell;
import jxl.biff.FormulaData;
import jxl.biff.IntegerHelper;
import jxl.biff.formula.FormulaException;
import jxl.biff.formula.FormulaParser;
import jxl.common.Assert;
import jxl.common.Logger;

/**
 * Class for read number formula records
 */
class ReadStringFormulaRecord extends ReadFormulaRecord
        implements StringFormulaCell {
    // the logger
    private static Logger logger = Logger.getLogger(ReadFormulaRecord.class);

    /**
     * Constructor
     *
     * @param f
     */
    public ReadStringFormulaRecord(FormulaData f) {
        super(f);
    }

    /**
     * Gets the string contents for this cell.
     *
     * @return the cell contents
     */
    public String getString() {
        return ((StringFormulaCell) getReadFormula()).getString();
    }

    /**
     * String formula specific exception handling.  Can't really create
     * a formula (as it will look for a cell of that name, so just
     * create a STRING record containing the contents
     *
     * @return the bodged data
     */
    protected byte[] handleFormulaException() {
        byte[] expressiondata = null;
        byte[] celldata = super.getCellData();

        // Generate an appropriate dummy formula
        WritableWorkbookImpl w = getSheet().getWorkbook();
        FormulaParser parser = new FormulaParser("\"" + getContents() + "\"", w, w,
                w.getSettings());

        // Get the bytes for the dummy formula
        try {
            parser.parse();
        } catch (FormulaException e2) {
            logger.warn(e2.getMessage());
            parser = new FormulaParser("\"ERROR\"", w, w, w.getSettings());
            try {
                parser.parse();
            } catch (FormulaException e3) {
                Assert.verify(false);
            }
        }
        byte[] formulaBytes = parser.getBytes();
        expressiondata = new byte[formulaBytes.length + 16];
        IntegerHelper.getTwoBytes(formulaBytes.length, expressiondata, 14);
        System.arraycopy(formulaBytes, 0, expressiondata, 16,
                formulaBytes.length);

        // Set the recalculate on load bit
        expressiondata[8] |= 0x02;

        byte[] data = new byte[celldata.length +
                expressiondata.length];
        System.arraycopy(celldata, 0, data, 0, celldata.length);
        System.arraycopy(expressiondata, 0, data,
                celldata.length, expressiondata.length);

        // Set the type bits to indicate a string formula
        data[6] = 0;
        data[12] = -1;
        data[13] = -1;

        return data;
    }
}
